/***************************************************************************
 * Copyright 2012-2013 TXT e-solutions SpA
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * This work was performed within the IoT_at_Work Project
 * and partially funded by the European Commission's
 * 7th Framework Programme under the contract ICT-257367.
 *
 * Authors:
 *      Salvatore Piccione (TXT e-solutions SpA)
 *
 * Contributors:
 *        Domenico Rotondi (TXT e-solutions SpA)
 **************************************************************************/
package it.txt.ens.schema.response.factory;

import it.txt.ens.schema.ResponseType;
import it.txt.ens.schema.factory.ENSResponseFactoryException;
import it.txt.ens.schema.factory.model.FailureResponseDetails;
import it.txt.ens.schema.factory.model.SuccessResponseDetails;

import java.io.InputStream;

import javax.xml.datatype.XMLGregorianCalendar;
import javax.xml.transform.Source;

import org.w3c.dom.Document;

/**
 * Defines methods to marshal and unmarshal {@link ResponseType} objects.
 * 
 * @author Salvatore Piccione (TXT e-solutions SpA - salvatore.piccione AT txtgroup.com)
 * @author Domenico Rotondi (TXT e-solutions SpA - domenico.rotondi AT txtgroup.com)
 *
 */
public interface ENSAuthorisationResponseFactory {
    public static final String JAXB_CONTEXT = "it.txt.access.capability.services.ens.schema";
    public static final String SIGN_DOCUMENT_AFTER_NODE = "ResponseID";
    public static final int ENSSERVICE_RESPONSE_VERSION = 0;
    public static final String SCHEMAS_DIRECTORY_PROP_KEY = "ens.authz.response.schemas.dir";
    
    public ResponseType unmarshal(Source source)
            throws ENSResponseFactoryException;

    public ResponseType parseInputStream(
            InputStream inputStream) throws ENSResponseFactoryException;

    public Document marshal(
            ResponseType response) throws ENSResponseFactoryException;

    public Document marshalIntoFragment(
            ResponseType response) throws ENSResponseFactoryException;

    public ResponseType createSuccessResponse(
            String requestID, XMLGregorianCalendar requestTimeStamp,
            SuccessResponseDetails details) throws ENSResponseFactoryException;

    public ResponseType createFailureResponse(
            String requestID, XMLGregorianCalendar requestTimeStamp,
            FailureResponseDetails details) throws ENSResponseFactoryException;
    
    public String getSchemasRootPath ();

}